package org.dromara.generator.util;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.lang.Dict;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.apache.velocity.VelocityContext;
import org.dromara.common.core.utils.DateUtils;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.json.utils.JsonUtils;
import org.dromara.common.mybatis.helper.DataBaseHelper;
import org.dromara.generator.constant.GenConstants;
import org.dromara.generator.domain.GenTable;
import org.dromara.generator.domain.GenTableColumn;

import java.util.*;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：模板处理工具类
 */
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class VelocityUtils {

    /**
     * 项目空间路径
     */
    private static final String PROJECT_PATH = "main/java";

    /**
     * mybatis空间路径
     */
    private static final String MYBATIS_PATH = "main/resources/mapper";

    /**
     * 默认上级菜单，系统工具
     */
    private static final String DEFAULT_PARENT_MENU_ID = "3";

    /**
     * 设置模板变量信息
     * 准备Velocity模板上下文
     * 将生成代码所需的信息封装到VelocityContext对象中
     *
     * @param genTable 代码生成配置表，包含生成代码所需的各种配置信息
     * @return 模板列表
     */
    public static VelocityContext prepareContext(GenTable genTable) {
        // 提取必要的配置信息
        // 获取模块名，用于确定代码生成的模块归属
        String moduleName = genTable.getModuleName();
        // 获取业务名称，用于区分不同的业务表
        String businessName = genTable.getBusinessName();
        // 获取项目包名，用于确定生成代码的包结构
        String packageName = genTable.getPackageName();
        // 获取模板分类，用于确定使用哪种模板生成代码
        String tplCategory = genTable.getTplCategory();
        // 获取功能名称，用于描述生成代码的功能模块
        String functionName = genTable.getFunctionName();

        // 创建Velocity上下文对象
        VelocityContext velocityContext = new VelocityContext();
        // 将模板类别放入上下文
        velocityContext.put("tplCategory", genTable.getTplCategory());
        // 将数据库表名放入上下文
        velocityContext.put("tableName", genTable.getTableName());
        // 将功能名称放入上下文，如果未设置则显示默认提示
        velocityContext.put("functionName", StringUtils.isNotEmpty(functionName) ? functionName : "【请填写功能名称】");
        // 将类名（大写首字母）放入上下文
        velocityContext.put("ClassName", genTable.getClassName());
        // 将类名（小写首字母）放入上下文
        velocityContext.put("className", StringUtils.uncapitalize(genTable.getClassName()));
        // 将模块名放入上下文
        velocityContext.put("moduleName", genTable.getModuleName());
        // 将业务名（大写首字母）放入上下文
        velocityContext.put("BusinessName", StringUtils.capitalize(genTable.getBusinessName()));
        // 将业务名放入上下文
        velocityContext.put("businessName", genTable.getBusinessName());
        // 将包的基础部分放入上下文
        velocityContext.put("basePackage", getPackagePrefix(packageName));
        // 将包名放入上下文
        velocityContext.put("packageName", packageName);
        // 将作者名称放入上下文
        velocityContext.put("author", genTable.getFunctionAuthor());
        // 将生成日期放入上下文
        velocityContext.put("datetime", DateUtils.getDate());
        // 将主键列名放入上下文
        velocityContext.put("pkColumn", genTable.getPkColumn());
        // 将导入列表放入上下文
        velocityContext.put("importList", getImportList(genTable));
        // 将权限前缀放入上下文
        velocityContext.put("permissionPrefix", getPermissionPrefix(moduleName, businessName));
        // 将列信息放入上下文
        velocityContext.put("columns", genTable.getColumns());
        // 将生成表信息放入上下文
        velocityContext.put("table", genTable);
        // 将字典信息放入上下文
        velocityContext.put("dicts", getDicts(genTable));
        // 设置菜单相关上下文信息
        setMenuVelocityContext(velocityContext, genTable);
        // 如果模板类别为树形，则设置树形相关上下文信息
        if (GenConstants.TPL_TREE.equals(tplCategory)) {
            setTreeVelocityContext(velocityContext, genTable);
        }
        // 返回准备好的Velocity上下文对象
        return velocityContext;
    }

    /**
     * 设置菜单相关数据到Velocity上下文中
     *
     * @param context Velocity上下文，用于传递数据到模板引擎
     * @param genTable 生成的表结构信息
     *
     * 此方法的作用是将菜单相关数据处理并放入Velocity上下文中，以便在代码生成过程中使用
     * 它从GenTable中获取options字段，解析其中的JSON数据，以获取父菜单ID（parentMenuId）
     * 然后将父菜单ID放入Velocity上下文中，以便在模板处理过程中可以访问到该数据
     *
     * 注意：此方法依赖于genTable的options字段包含有效的JSON数据，且其中包含parentMenu字段
     */
    public static void setMenuVelocityContext(VelocityContext context, GenTable genTable) {
        // 解析GenTable的options字段获取JSON数据
        String options = genTable.getOptions();
        Dict paramsObj = JsonUtils.parseMap(options);
        // 获取父菜单ID
        String parentMenuId = getParentMenuId(paramsObj);
        // 将父菜单ID放入Velocity上下文中
        context.put("parentMenuId", parentMenuId);
    }

    /**
     * 设置树结构的Velocity上下文
     * 该方法通过解析表配置的参数，将树结构相关变量添加到Velocity上下文中，以便在模板引擎中使用
     *
     * @param context Velocity上下文对象，用于存储模板变量
     * @param genTable 代码生成的表配置信息对象，包含生成代码所需的各种配置
     */
    public static void setTreeVelocityContext(VelocityContext context, GenTable genTable) {
        // 获取表配置的额外选项参数
        String options = genTable.getOptions();
        // 将选项参数从JSON字符串解析为字典对象，便于后续操作
        Dict paramsObj = JsonUtils.parseMap(options);
        // 获取树结构的编码字段名
        String treeCode = getTreecode(paramsObj);
        // 获取树结构的父编码字段名
        String treeParentCode = getTreeParentCode(paramsObj);
        // 获取树结构的名称字段名
        String treeName = getTreeName(paramsObj);

        // 将树结构的编码字段名放入Velocity上下文中
        context.put("treeCode", treeCode);
        // 将树结构的父编码字段名放入Velocity上下文中
        context.put("treeParentCode", treeParentCode);
        // 将树结构的名称字段名放入Velocity上下文中
        context.put("treeName", treeName);
        // 将树结构的展开列配置放入Velocity上下文中
        context.put("expandColumn", getExpandColumn(genTable));
        // 如果配置中包含父编码字段，则将其放入Velocity上下文中
        if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
            context.put("tree_parent_code", paramsObj.get(GenConstants.TREE_PARENT_CODE));
        }
        // 如果配置中包含名称字段，则将其放入Velocity上下文中
        if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
            context.put("tree_name", paramsObj.get(GenConstants.TREE_NAME));
        }
    }

    /**
     * 获取模板信息
     *
     * 根据模板类别获取模板列表
     * @param tplCategory 模板类别，用于区分不同类型的模板
     * @return 模板列表
     */
    public static List<String> getTemplateList(String tplCategory) {
        // 创建一个用于存储模板路径的列表
        List<String> templates = new ArrayList<>();
        // 添加Java层模板文件路径
        templates.add("vm/java/domain.java.vm");
        templates.add("vm/java/vo.java.vm");
        templates.add("vm/java/bo.java.vm");
        templates.add("vm/java/mapper.java.vm");
        templates.add("vm/java/service.java.vm");
        templates.add("vm/java/serviceImpl.java.vm");
        templates.add("vm/java/controller.java.vm");
        // 添加XML层模板文件路径
        templates.add("vm/xml/mapper.xml.vm");
        // 根据数据库类型添加相应的SQL模板文件路径
        if (DataBaseHelper.isOracle()) {
            templates.add("vm/sql/oracle/sql.vm");
        } else if (DataBaseHelper.isPostgerSql()) {
            templates.add("vm/sql/postgres/sql.vm");
        } else if (DataBaseHelper.isSqlServer()) {
            templates.add("vm/sql/sqlserver/sql.vm");
        } else {
            templates.add("vm/sql/sql.vm");
        }
        // 添加TypeScript层模板文件路径
        templates.add("vm/ts/api.ts.vm");
        templates.add("vm/ts/types.ts.vm");
        // 根据不同的模板类别添加Vue层模板文件路径
        if (GenConstants.TPL_CRUD.equals(tplCategory)) {
            templates.add("vm/vue/index.vue.vm");
        } else if (GenConstants.TPL_TREE.equals(tplCategory)) {
            templates.add("vm/vue/index-tree.vue.vm");
        }
        return templates;
    }

    /**
     * 获取文件名
     *
     * @param template 模板名称，用于区分不同类型的模板
     * @param genTable 待生成文件的表信息对象
     * @return 生成的文件名
     */
    public static String getFileName(String template, GenTable genTable) {
        // 文件名称
        String fileName = "";
        // 包路径
        String packageName = genTable.getPackageName();
        // 模块名
        String moduleName = genTable.getModuleName();
        // 大写类名
        String className = genTable.getClassName();
        // 业务名称
        String businessName = genTable.getBusinessName();
        // 根据项目路径和包名构造Java文件的路径，使用/代替包名中的.以适应文件系统结构
        String javaPath = PROJECT_PATH + "/" + StringUtils.replace(packageName, ".", "/");
        // 构造MyBatis相关文件的路径，基于MyBatis基础路径和模块名称
        String mybatisPath = MYBATIS_PATH + "/" + moduleName;
        // 定义Vue相关文件的路径，此处简单设定为"vue"，暗示后续操作可能与Vue框架相关
        String vuePath = "vue";

        // 根据模板名称中的关键字，生成对应模块的文件
        // 这些条件判断用于确定文件的路径和名称结构
        if (template.contains("domain.java.vm")) {
            // 生成实体类文件
            fileName = StringUtils.format("{}/domain/{}.java", javaPath, className);
        }
        if (template.contains("vo.java.vm")) {
            // 生成值对象（Value Object）类文件
            fileName = StringUtils.format("{}/domain/vo/{}Vo.java", javaPath, className);
        }
        if (template.contains("bo.java.vm")) {
            // 生成业务对象（Business Object）类文件
            fileName = StringUtils.format("{}/domain/bo/{}Bo.java", javaPath, className);
        }
        if (template.contains("mapper.java.vm")) {
            // 生成Mapper接口文件
            fileName = StringUtils.format("{}/mapper/{}Mapper.java", javaPath, className);
        } else if (template.contains("service.java.vm")) {
            // 生成服务接口文件
            fileName = StringUtils.format("{}/service/I{}Service.java", javaPath, className);
        } else if (template.contains("serviceImpl.java.vm")) {
            // 生成服务实现类文件
            fileName = StringUtils.format("{}/service/impl/{}ServiceImpl.java", javaPath, className);
        } else if (template.contains("controller.java.vm")) {
            // 生成控制器类文件
            fileName = StringUtils.format("{}/controller/{}Controller.java", javaPath, className);
        } else if (template.contains("mapper.xml.vm")) {
            // 生成MyBatis映射文件
            fileName = StringUtils.format("{}/{}Mapper.xml", mybatisPath, className);
        } else if (template.contains("sql.vm")) {
            // 生成SQL脚本文件
            fileName = businessName + "Menu.sql";
        } else if (template.contains("api.ts.vm")) {
            // 生成Vue项目中的API TypeScript文件
            fileName = StringUtils.format("{}/api/{}/{}/index.ts", vuePath, moduleName, businessName);
        } else if (template.contains("types.ts.vm")) {
            // 生成Vue项目中的类型定义TypeScript文件
            fileName = StringUtils.format("{}/api/{}/{}/types.ts", vuePath, moduleName, businessName);
        } else if (template.contains("index.vue.vm")) {
            // 生成Vue项目中的Vue组件文件
            fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
        } else if (template.contains("index-tree.vue.vm")) {
            // 生成带有树结构的Vue组件文件
            fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
        }
        return fileName;
    }

    /**
     * 获取包前缀
     *
     * @param packageName 包名称
     * @return 包前缀名称
     */
    public static String getPackagePrefix(String packageName) {
        // 找到包名中最后一个"."的位置
        int lastIndex = packageName.lastIndexOf(".");
        // 返回包名中从开头到最后一个"."之前的子字符串
        return StringUtils.substring(packageName, 0, lastIndex);
    }

    /**
     * 根据列类型获取导入包
     *
     * @param genTable 业务表对象
     * @return 返回需要导入的包列表
     */
    public static HashSet<String> getImportList(GenTable genTable) {
        // 获取表列信息
        List<GenTableColumn> columns = genTable.getColumns();
        HashSet<String> importList = new HashSet<>();
        for (GenTableColumn column : columns) {
            // 判断当前字段是否为超级列并且是时间类型
            if (!column.isSuperColumn() && GenConstants.TYPE_DATE.equals(column.getJavaType())) {
                importList.add("java.util.Date");
                importList.add("com.fasterxml.jackson.annotation.JsonFormat");
                // 判断当前字段是否为超级列并且是高精度计算类型
            } else if (!column.isSuperColumn() && GenConstants.TYPE_BIGDECIMAL.equals(column.getJavaType())) {
                importList.add("java.math.BigDecimal");
            }
        }
        return importList;
    }

    /**
     * 根据列类型获取字典组
     *
     * @param genTable 业务表对象
     * @return 返回字典组
     */
    public static String getDicts(GenTable genTable) {
        // 获取表列信息
        List<GenTableColumn> columns = genTable.getColumns();
        Set<String> dicts = new HashSet<>();
        // 添加字典列表
        addDicts(dicts, columns);
        // 使用逗号和空格连接集合中的所有字典类型名称，形成一个字符串
        return StringUtils.join(dicts, ", ");
    }

    /**
     * 添加字典列表
     *
     * @param dicts 字典列表
     * @param columns 列集合
     */
    public static void addDicts(Set<String> dicts, List<GenTableColumn> columns) {
        for (GenTableColumn column : columns) {
            // 判断判断当前字段是否为超级列且字典类型不为空且显示类型
            // （input文本框、textarea文本域、select下拉框、checkbox复选框、radio单选框、datetime日期控件、image图片上传控件、upload文件上传控件、editor富文本控件）
            if (!column.isSuperColumn() && StringUtils.isNotEmpty(column.getDictType()) && StringUtils.equalsAny(
                column.getHtmlType(),
                // 当列的HTML类型为下拉框 + 单选框 + 复选框添加到字典集合中
                // 这是因为这些HTML组件需要绑定字典数据以进行选项展示，因此需要动态获取字典类型
                new String[] { GenConstants.HTML_SELECT, GenConstants.HTML_RADIO, GenConstants.HTML_CHECKBOX })) {
                dicts.add("'" + column.getDictType() + "'");
            }
        }
    }

    /**
     * 获取权限前缀
     *
     * @param moduleName   模块名称
     * @param businessName 业务名称
     * @return 返回权限前缀
     */
    public static String getPermissionPrefix(String moduleName, String businessName) {
        // 将模块名和业务名格式化为一个键值对字符串
        // 使用冒号分隔模块名和业务名，以清晰地区分两者
        return StringUtils.format("{}:{}", moduleName, businessName);
    }

    /**
     * 获取上级菜单ID字段
     *
     * @param paramsObj 生成其他选项
     * @return 上级菜单ID字段
     */
    public static String getParentMenuId(Dict paramsObj) {
        // 检查paramsObj是否非空、包含上级菜单ID字段以及上级菜单ID字段非空
        if (CollUtil.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.PARENT_MENU_ID)
            && StringUtils.isNotEmpty(paramsObj.getStr(GenConstants.PARENT_MENU_ID))) {
            return paramsObj.getStr(GenConstants.PARENT_MENU_ID);
        }
        // 如果不满足条件，返回默认的父菜单ID
        return DEFAULT_PARENT_MENU_ID;
    }

    /**
     * 获取树编码
     * 获取树编码的驼峰命名
     *
     * @param paramsObj 生成其他选项，包含树编码等信息
     * @return 树编码  树编码的驼峰命名如果参数对象不为空且包含树编码，则返回转换后的驼峰命名；否则返回空字符串
     */
    public static String getTreecode(Map<String, Object> paramsObj) {
        // 检查参数对象是否非空且包含树编码键值对
        if (CollUtil.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_CODE)) {
            // 将树编码转换为字符串，并转换为驼峰命名后返回
            return StringUtils.toCamelCase(Convert.toStr(paramsObj.get(GenConstants.TREE_CODE)));
        }
        // 参数对象为空或不包含树编码键值对时，返回空字符串
        return StringUtils.EMPTY;
    }

    /**
     * 获取树父编码
     * 获取树结构的父级代码字段名
     * 该方法用于从配置对象中提取树结构的父级代码字段名，如果存在且不为空，则将其转换为驼峰命名格式
     *
     * @param paramsObj 生成其他选项 包含模块参数的字典对象，用于存储模块配置信息
     * @return 树父编码 树结构的父级代码字段名，转换为驼峰命名格式如果paramsObj为空或不包含树结构的父级代码字段，则返回空字符串
     */
    public static String getTreeParentCode(Dict paramsObj) {
        // 检查paramsObj是否非空且包含树父编码字段
        if (CollUtil.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
            // 提取树父编码字段字段，并转换为驼峰命名格式
            return StringUtils.toCamelCase(paramsObj.getStr(GenConstants.TREE_PARENT_CODE));
        }
        // 如果paramsObj为空或不包含树父编码字段，则返回空字符串
        return StringUtils.EMPTY;
    }

    /**
     * 获取树名称
     * 计算在代码生成时，需要设置为可展开列的数量
     * 此方法用于根据 GenTable 对象计算并返回需要展开的列数，主要是为了适应树形结构的表
     *
     * @param paramsObj 生成其他选项 包含了表的元数据以及生成代码的配置信息
     * @return 树名称 需要展开的列的数量
     */
    public static String getTreeName(Dict paramsObj) {
        // 如果其他选项不为空和包含树名称字段
        if (CollUtil.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.TREE_NAME)) {
            // 将树名称字段转换为驼峰命名法
            return StringUtils.toCamelCase(paramsObj.getStr(GenConstants.TREE_NAME));
        }
        return StringUtils.EMPTY;
    }

    /**
     * 获取需要在哪一列上面显示展开按钮
     *
     * @param genTable 业务表对象
     * @return 展开按钮列序号
     */
    public static int getExpandColumn(GenTable genTable) {
        // 获取表的配置信息，这部分信息通常用于控制代码生成的特定设置
        String options = genTable.getOptions();
        // 将配置信息解析为一个字典对象，便于后续访问
        Dict paramsObj = JsonUtils.parseMap(options);
        // 获取树形结构的名称，用于标识树形结构的列
        String treeName = paramsObj.getStr(GenConstants.TREE_NAME);
        // 初始化计数器，用于记录需要展开的列的数量
        int num = 0;
        // 遍历表的所有列，检查每一列是否需要在生成的代码中设置为可展开列
        for (GenTableColumn column : genTable.getColumns()) {
            // 如果当前列是一个列表列（通常意味着它可能是一个树形结构的子节点）
            if (column.isList()) {
                // 增加需要展开的列的数量
                num++;
                // 获取当前列的名称
                String columnName = column.getColumnName();
                // 如果当前列名称与树形结构的名称匹配，说明找到了树形结构的父节点列
                if (columnName.equals(treeName)) {
                    // 停止遍历，因为已经找到了树形结构的父节点列，无需继续
                    break;
                }
            }
        }
        // 返回需要展开的列的数量
        return num;
    }
}
